Get Accounts Metrics

GET /accounts/metrics

Description

Retrieve metrics related to user accounts within a specified date range, allowing customization through various parameters.

Query Parameters

Name	Type	Description
from*	string	(Required). Start date for the metrics period. Include in the request query parameters.
to*	string	(Required). End date for the metrics period. Include in the request query parameters.
groupBy*	array[string]	(Required). Group the metrics by specific criteria. Available values: CURRENCY, USER_ID, TENANT_ID, CATEGORY, PROVIDER, STATUS, PRODUCT_TYPE, LEVEL, USER_PROFILE_ID. Include in the request query parameters.
filterByCurrency*	array[string]	(Optional). Filter metrics by currency. Include in the request query parameters.
filterByTenantId*	array[string]	(Optional). Filter metrics by tenant ID. Include in the request query parameters.
filterByWalletUserId*	array[string]	(Optional). Filter metrics by wallet user ID. Include in the request query parameters.
filterByCategory*	array[string]	(Optional). Filter metrics by category. Include in the request query parameters.
filterByProvider*	array[string]	(Optional). Filter metrics by provider. Include in the request query parameters.
filterByStatus*	array[string]	(Optional). Filter metrics by status. Include in the request query parameters.
filterByProductType*	array[string]	(Optional). Filter metrics by product type. Include in the request query parameters.
filterByLevel*	array[string]	(Optional). Filter metrics by level. Include in the request query parameters.
filterByUserProfileId*	array[string]	(Optional). Filter metrics by user profile ID. Include in the request query parameters.

Try it yourself

curl --location 'http://20.87.230.105/platform/wallets/accounts/metrics' \
--header 'apiKey: 6987f1c0-f01f-4b31-86e5-416ccaa906de' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJfaWQiOiI2NGQ2NmNmYWQ2NWQ1NTNhZDYwOTBiY2IiLCJmaXJzdE5hbWUiOiJTQUJJIE5HIiwibGFzdE5hbWUiOiJQbGF0Zm9ybSIsInVzZXJuYW1lIjoidGVjaEBzYWJpLmFtIiwicGFzc3dvcmQiOm51bGwsInR5cGUiOiJVU0VSIiwiY291bnRyeSI6eyJuYW1lIjoiTmlnZXJpYSIsImNvZGUiOiJORyIsImN1cnJlbmN5IjoiTkdOIiwiX2lkIjoiNjRkNjZjZmFkNjVkNTUzYWQ2MDkwYmNjIn0sInRlbmFudHMiOlsiNjRkYjY4NmIzZjljNGJjMThkNWM2NTA3IiwiNjRmYjMzYjEwMTUzMWNkYWFhZTlkMzM5Il0sInJvbGVzIjpbIlRFTkFOVF9TVVBFUl9BRE1JTiIsIlRFTkFOVF9BRE1JTiJdLCJpYXQiOjE3MDIyOTgyODgsImV4cCI6MTcwMjkwMzA4OH0.9BIMwE8o52p1-KPX9M7xmtXVNC86yWypbUejtMpvJC8'

Response Code: 200 - OK

Description

Account metrics returned successfully.

Response Field

Field	Type	Description
status	boolean	Indicates the overall success of the operation.
statusCode	integer	Represents the specific status code for the response.
message	string	Provides additional information about the response.
data	object	Contains the main data payload of the response.
errors	array	An array containing error details if issues occurred.
- message	string	Describes the error.
- descriptiveMessage	string	Provides a more detailed and descriptive message about the error.

Example

<response>
  <status>true</status>
  <statusCode>0</statusCode>
  <message>string</message>
  <data></data>
  <errors>
    <error>
      <message>string</message>
      <descriptiveMessage>string</descriptiveMessage>
    </error>
  </errors>
</response>

---

Response Code: 400 - Bad Request

Description

Invalid account.

Example

<response>
  <status>false</status>
  <statusCode>400</statusCode>
  <message>Invalid account id</message>
  <data></data>
  <errors>
    <error>
      <message>Invalid account id</message>
      <descriptiveMessage></descriptiveMessage>
    </error>
  </errors>
</response>

curlUrl: "/accounts/metrics" curlMethod: GET

Response Code: 404 - Not Found

Description

Account not found.

Example

<response>
  <status>false</status>
  <statusCode>404</statusCode>
  <message>Account id not found</message>
  <data></data>
  <errors>
    <error>
      <message>Account id not found</message>
      <descriptiveMessage></descriptiveMessage>
    </error>
  </errors>
</response>

Method: GET

>http://20.87.230.105/platform/wallets/accounts/metrics

Headers

Content-Type	Value
apiKey	{{apiKey}}

🔑 Authentication bearer

Param	value	Type
token	{{accessCode}}	string